home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 014 / pibcat.arc / PIBCAT.DOC < prev    next >
Encoding:
Text File  |  1987-01-20  |  4.1 KB  |  137 lines
  1. Introduction
  2. ============
  3.  
  4. PIBCAT.COM is a disk-cataloguing program.  It lists all files in all
  5. subdirectories on a given disk, and also lists the entries in .ARC and
  6. .LBR files.  You may indicate a match criterion for files, and you may
  7. suppress the .ARC/.LBR expansion listing.
  8.  
  9.  
  10. Restrictions on use
  11. ===================
  12.  
  13. None.  However, I ask that you give me credit if you use any part of
  14. this code in developing other software, and I STRONGLY urge you to
  15. release the source code for such projects so all of us can benefit.
  16. If you make any nifty changes or enhancements to PibCat itself, PLEASE
  17. upload the changes so all of us can profit by them.
  18.  
  19.  
  20. Usage
  21. =====
  22.  
  23.     PIBCAT v /f=filespec /i=indent /m=margin /o=filename /p=pagesize /x
  24.  
  25.        v               volume (drive letter) to catalog
  26.                        (default is current drive)
  27.                        If given as ?, this text is displayed.
  28.  
  29.        /f=filespec     DOS file spec to match when listing
  30.                        (default is *.* -- list all files)
  31.  
  32.        /i=indent       # columns to space for .ARC/.LBR entries
  33.                        (default is 0)
  34.  
  35.        /m=margin       left margin to leave (default is 0)
  36.  
  37.        /o=filename     write catalog listing to file "filename"
  38.                        (default is "CATALOG.LIS")
  39.  
  40.        /p=pagesize     paginate listing using "pagesize" lines
  41.                        (default is no pagination)
  42.  
  43.        /x              don't list .ARC/.LBR file contents
  44.                        (default is to list .ARC/.LBR contents)
  45.  
  46.  
  47. Aborting
  48. ========
  49.  
  50. Hit ^C to abort catalog listing.
  51.  
  52.  
  53. Output
  54. ======
  55.  
  56. For each selected file, the file name, size in bytes, and time
  57. and date of creation are displayed.  The files are displayed in
  58. sorted order by name.  All subdirectories of each directory
  59. are searched and listed automatically.  By default, a non-paginated
  60. listing is written to CATALOG.LIS.  Use /p= to get a paginated
  61. listing (each page has a page number and is separated from the
  62. previous page by an Ascii form-feed character  (^L) ).
  63.  
  64. The same file name, size, and time/date information is presented
  65. for members of .ARC or .LBR files.  The file names within .ARC or
  66. .LBR files are NOT sorted.  However, most .ARC files are created
  67. with names in sorted order anyway.
  68.  
  69. For .LBR files, the time and date of the last update for each member,
  70. not the original creation time and date, are displayed.  Some .LBR
  71. files do not record creation or update times, and in that case, the
  72. time/date fields are not displayed.
  73.  
  74.  
  75. System requirements
  76. ===================
  77.  
  78. IBM PC or compatible under MS DOS or PC DOS v2.0 or higher with
  79. at least 128K of RAM.
  80.  
  81.  
  82. Examples
  83. ========
  84.  
  85. To get abbreviated help:
  86.  
  87.    PIBCAT ?
  88.  
  89. To catalog the currently logged disk:
  90.  
  91.    PIBCAT
  92.  
  93. To catalog disk C:
  94.  
  95.    PIBCAT C
  96.  
  97. The output goes to file CATALOG.LIS by default.  To specify an alternate
  98. output file called MYDIR.LIS:
  99.  
  100.    PIBCAT C /O=MYDIR.LIS
  101.  
  102. To select a match criterion:
  103.  
  104.    PIBCAT C /F=*.bat       ==> only list .BAT files
  105.    PIBCAT C /F=\bozo       ==> only list files in C:\bozo\ and its
  106.                                subdirectories
  107.  
  108. To get a paginated listing:
  109.  
  110.    PIBCAT /P=60            ==> Paginated listing assuming 60 lines per page
  111.                                (Form feeds separate pages)
  112.  
  113. To get the listing indented (perhaps for binding):
  114.  
  115.    PIBCAT /M=10            ==> Indent listing file by 10 columns
  116.  
  117. To indent the .ARC/.LBR listings further than the directory listings:
  118.  
  119.    PIBCAT /I=5             ==> Indent .ARC/.LBR listings 5 columns further
  120.                                to right than directory listings
  121.  
  122. To prevent .ARC/.LBR contents listing:
  123.  
  124.    PIBCAT /X               ==> No expansion of .ARC/.LBR
  125.  
  126. Of course the various parameters can be used together.
  127.  
  128.  
  129. Acknowledgments
  130. ===============
  131.  
  132. The archive search code is based in part on TPARCV.PAS by Michael Quinlan
  133. and ARCV.ASM by Vern Buerg.  The library search code is based in part upon
  134. LU.PAS by Steve Freeman.  Bob Blacher was very helpful in testing PibCat.
  135.  
  136. -- Phil Burns
  137.    January 20, 1987